Payment Methods Biz API
POST-paymentMethod (Digital to SF)
POST
This operation allows to create a payment method
Request
This section defines all the possible data structures sent by the client when consuming the method.
URL PARAMS
| name | type | description | required |
|---|---|---|---|
| businessId | string | 2 letter ISO 3166 country code (PR) identifying the business unit. | Y |
Security Headers
| name | type | description | required |
|---|---|---|---|
| client_id | string | The client_id identifying the channel. Minimum characters: 5 | Y |
| client_secret | string | Password associated with the client_id. Minimum characters: 5 | Y |
Header
| name | type | description | required |
|---|---|---|---|
| X-Correlation-ID | string | Identifier that correlates HTTP request between a client and server. Any identification model (UUDI, checksum, etc.) can be used, as long as it is a unique value to differentiate a transaction. | N |
Body
Request Body for PR
{
"token": "cGF5bWVudG1ldGhvZF9jY181a25obmtzZg",
"account": [
{
"id": "31516278-31514752",
"@type": "BillingAccount",
"relatedParty": [
{
"id": "12401231232",
"@type": "msisdn"
}
]
}
],
"relatedParty": [
{
"name": "BrainTreeToken",
"@type": "paymentGatewayType"
},
{
"@type": "channel",
"name": "Digital"
},
{
"@type": "restrictOrder",
"name": "true"
}
]
}Definitions
Each of the request parameters is detailed.
| name | type | description | required | possible values |
|---|---|---|---|---|
| token | string | Braintree token | Y | cGF5bWVudG1ldGhvZF9jY19i |
| account | array | Y | ||
| account.id | string | Value of Billing Account Number Conditional mandatory. either Billing Account Number or MSISDN should be passed | Y* | BANXXXX-CANYYY |
| account.@type | string | type of account.here it is Billing Account | N | BillingAccount |
| account.relatedParty | array | Y* | ||
| account.relatedParty.id | string | Value of MSISDN Conditional mandatory. either Billing Account Number or MSISDN should be passed | Y* | 649824098 |
| account.relatedParty.@type | string | type is MSISDN | N | msisdn |
| relatedParty | array | Y | ||
| relatedParty.name | string | Name of the relatedParty | Y | BrainTreeToken, Digital/IVR |
| relatedParty.@type | string | Type of the relatedParty | Y | paymentGatewayType, channel |
Response
######
Response
In this section all the possible data structures received by the client at the moment of responding the method are defined.
Possible response success
This section defines all the possible data structures received by the client and that must be considered satisfactory at the time of responding to the method.
[ 201 ]
OK - POST request processed successfully, response body contains an entity corresponding to the requested resource.
{
"description": "payment method create request received"
}